/**
 * Copyright (c) 2021, The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package android.service.dreams;

import android.service.dreams.IDreamOverlayClientCallback;

/**
* {@link IDreamOverlay} provides a way for a component to annotate a dream with additional view
* elements. Registered through the DreamManager, a IDreamOverlay is bound to by the dream and
* passed the necessary window details to participate in the user interface.

* @hide
*/
interface IDreamOverlay {
    /**
    * Retrieves a client the caller can use to interact with the dream overlay.
    */
    void getClient(in IDreamOverlayClientCallback callback);
}
